Vcenter VM Info

Vcenter VM Info
Vcenter VM Info

Document-based info.

JSON Example
{
    "guest_os": "string",
    "name": "string",
    "identity": {
        "name": "string",
        "bios_uuid": "string",
        "instance_uuid": "string"
    },
    "power_state": "string",
    "instant_clone_frozen": false,
    "hardware": {
        "version": "string",
        "upgrade_policy": "string",
        "upgrade_version": "string",
        "upgrade_status": "string",
        "upgrade_error": {}
    },
    "boot": {
        "type": "string",
        "efi_legacy_boot": false,
        "network_protocol": "string",
        "delay": 0,
        "retry": false,
        "retry_delay": 0,
        "enter_setup_mode": false
    },
    "boot_devices": [
        {
            "type": "string",
            "nic": "string",
            "disks": [
                "string"
            ]
        }
    ],
    "cpu": {
        "count": 0,
        "cores_per_socket": 0,
        "hot_add_enabled": false,
        "hot_remove_enabled": false
    },
    "memory": {
        "size_mib": 0,
        "hot_add_enabled": false,
        "hot_add_increment_size_mib": 0,
        "hot_add_limit_mib": 0
    },
    "disks": {
        "disks": {
            "label": "string",
            "type": "string",
            "ide": {
                "primary": false,
                "master": false
            },
            "scsi": {
                "bus": 0,
                "unit": 0
            },
            "sata": {
                "bus": 0,
                "unit": 0
            },
            "nvme": {
                "bus": 0,
                "unit": 0
            },
            "backing": {
                "type": "string",
                "vmdk_file": "string"
            },
            "capacity": 0
        }
    },
    "nics": {
        "nics": {
            "label": "string",
            "type": "string",
            "upt_compatibility_enabled": false,
            "upt_v2_compatibility_enabled": false,
            "mac_type": "string",
            "mac_address": "string",
            "pci_slot_number": 0,
            "wake_on_lan_enabled": false,
            "backing": {
                "type": "string",
                "network": "string",
                "network_name": "string",
                "host_device": "string",
                "distributed_switch_uuid": "string",
                "distributed_port": "string",
                "connection_cookie": 0,
                "opaque_network_type": "string",
                "opaque_network_id": "string"
            },
            "state": "string",
            "start_connected": false,
            "allow_guest_control": false
        }
    },
    "cdroms": {
        "cdroms": {
            "type": "string",
            "label": "string",
            "ide": {
                "primary": false,
                "master": false
            },
            "sata": {
                "bus": 0,
                "unit": 0
            },
            "backing": {
                "type": "string",
                "iso_file": "string",
                "host_device": "string",
                "auto_detect": false,
                "device_access_type": "string"
            },
            "state": "string",
            "start_connected": false,
            "allow_guest_control": false
        }
    },
    "floppies": {
        "floppies": {
            "label": "string",
            "backing": {
                "type": "string",
                "image_file": "string",
                "host_device": "string",
                "auto_detect": false
            },
            "state": "string",
            "start_connected": false,
            "allow_guest_control": false
        }
    },
    "parallel_ports": {
        "parallel_ports": {
            "label": "string",
            "backing": {
                "type": "string",
                "file": "string",
                "host_device": "string",
                "auto_detect": false
            },
            "state": "string",
            "start_connected": false,
            "allow_guest_control": false
        }
    },
    "serial_ports": {
        "serial_ports": {
            "label": "string",
            "yield_on_poll": false,
            "backing": {
                "type": "string",
                "file": "string",
                "host_device": "string",
                "auto_detect": false,
                "pipe": "string",
                "no_rx_loss": false,
                "network_location": "string",
                "proxy": "string"
            },
            "state": "string",
            "start_connected": false,
            "allow_guest_control": false
        }
    },
    "sata_adapters": {
        "sata_adapters": {
            "label": "string",
            "type": "string",
            "bus": 0,
            "pci_slot_number": 0
        }
    },
    "scsi_adapters": {
        "scsi_adapters": {
            "label": "string",
            "type": "string",
            "scsi": {
                "bus": 0,
                "unit": 0
            },
            "pci_slot_number": 0,
            "sharing": "string"
        }
    },
    "nvme_adapters": {
        "nvme_adapters": {
            "label": "string",
            "bus": 0,
            "pci_slot_number": 0
        }
    }
}
string
guest_os
Required

Guest OS.

For more information see: Vcenter Vm GuestOS.

string
name
Required

Virtual machine name.

identity
Optional

Identity of the virtual machine.

This property was added in vSphere API 6.7.1.

This property is optional because it was added in a newer version than its parent node.

string
power_state
Required

Power state of the virtual machine.

For more information see: Vcenter Vm Power State.

boolean
instant_clone_frozen
Optional

Indicates whether the virtual machine is frozen for instant clone, or not.

This property was added in vSphere API 6.7.1.

This property is optional because it was added in a newer version than its parent node.

hardware
Required

Virtual hardware version information.

boot
Required

Boot configuration.

boot_devices
Required

Boot device configuration. If the list has no entries, a server-specific default boot sequence is used.

cpu
Required

CPU configuration.

memory
Required

Memory configuration.

object
disks
Required

List of disks.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

object
nics
Required

List of Ethernet adapters.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

object
cdroms
Required

List of CD-ROMs.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

object
floppies
Required

List of floppy drives.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

object
parallel_ports
Required

List of parallel ports.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

object
serial_ports
Required

List of serial ports.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

object
sata_adapters
Required

List of SATA adapters.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

object
scsi_adapters
Required

List of SCSI adapters.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.

object
nvme_adapters
Optional

List of NVMe adapters.

This property was added in vSphere API 7.0.0.1.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter.

Returned By